Restructure project #410

mattphillips · 2022-01-29T22:01:34Z

What

Move predicate contents into matcher file
Delete predicate tests in favour of matcher tests
Move matcher tests to test/matchers/[matcher].js
Move match from src/matchers/[matcher]/index.js to src/matchers/[matcher].js
Inline messages into matcher body to remove passing this.utils around.

Why

This will simplify the codebase and we be closer to Typescript structured projects as I'd like to migrate to TS once this change is in.

Notes

Although I've deleted all predicate.test.js files coverage is still 100% and none of the snapshots have changed so I'm confident that everything is working as it was before.

Housekeeping

Unit tests
Documentation is up to date
No additional lint warnings
Typescript definitions are added/updated where relevant

igorwessel · 2022-01-30T10:26:25Z

If you need any help either here or in the ts part, I'm available.

codecov · 2022-01-31T09:49:04Z

Codecov Report

Merging #410 (06c8051) into main (e52cd5d) will not change coverage.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##              main      #410    +/-   ##
==========================================
  Coverage   100.00%   100.00%            
==========================================
  Files          137        71    -66     
  Lines          853       575   -278     
  Branches       143       146     +3     
==========================================
- Hits           853       575   -278

Impacted Files	Coverage Δ
src/utils/print.js	`100.00% <ø> (ø)`
src/matchers/fail.js	`100.00% <100.00%> (ø)`
src/matchers/pass.js	`100.00% <100.00%> (ø)`
src/matchers/toBeAfter.js	`100.00% <100.00%> (ø)`
src/matchers/toBeAfterOrEqualTo.js	`100.00% <100.00%> (ø)`
src/matchers/toBeArray.js	`100.00% <100.00%> (ø)`
src/matchers/toBeArrayOfSize.js	`100.00% <100.00%> (ø)`
src/matchers/toBeBefore.js	`100.00% <100.00%> (ø)`
src/matchers/toBeBeforeOrEqualTo.js	`100.00% <100.00%> (ø)`
src/matchers/toBeBetween.js	`100.00% <100.00%> (ø)`
... and 61 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e52cd5d...06c8051. Read the comment docs.

mattphillips · 2022-01-31T16:40:00Z

@igorwessel thanks for the offer I think this PR is sorted now but will deffo take you up on the TS offer. I'll also try to go over the TS issue you raised in the next few days when I get some time 😊

CONTRIBUTING.md

src/matchers/toBeAfterOrEqualTo/predicate.test.js

src/matchers/toThrowWithMessage/predicate.test.js

src/matchers/toBeBefore/predicate.test.js

src/matchers/toBeBetween/predicate.test.js

src/matchers/toBeEmpty/predicate.test.js

keeganwitt · 2022-02-01T02:59:11Z

Do we want to continue having JSDoc on the new functions?

SimenB · 2022-02-01T09:41:52Z

package.json

+    "moduleNameMapper": {
+      "src/(.*)": "<rootDir>/src/$1"
+    },


why do we want this? seems likely to only cause confusion for most tools

So that we can import from src in the test files as src/ and test/ are at the same level in the directory instead of having to add ../.. to all imports.

right, but is avoiding ../ worth breaking "go to definition" etc?

I don't really have a strong opinion here (nor ownership 😀) but in the same way removing the import.all macro makes things not require specific tooling I don't think configuring the resolver of jest and eslint (and later typescript I assume) keeps the code base as approachable as possible.

(if we want something like this, we should use https://nodejs.org/api/packages.html#subpath-imports or something that has an actual spec behind it instead of ad hoc config. That said, Jest does not support it (yet)).

Again, this is your project, not mine, so feel free to structure it how you want to 🙂 Just putting my opinion out there, because what else is the internet for?

Again, this is your project, not mine, so feel free to structure it how you want to 🙂 Just putting my opinion out there, because what else is the internet for?

Love this 😆 your opinions are always welcome!

Tbh I setup all of my Typescript projects with the ability to import from src to make it easy to do absolute imports and move stuff around. With vscode at least (when using TS) importing from src doesn't break go to definition, do you know if it does in other editors?

I kind of see this PR as a precursor to switching to TS so hopefully the tooling will be better then.

This all probably stems from my Java days and when I work in Scala and being able to treat directories as packages/namespaces regardless of source set 😝

I've been writing Rust lately, so I feel this 😀

keeganwitt · 2022-02-22T05:52:01Z

Do we want to continue having JSDoc on the new functions?

Actually, only toContainAnyValues/predicate.ts and toBeArrayOfSize/predicate.ts had JSDoc (besides index.d.ts), so we don't need to worry about that. I just randomly happened to look at one of those two that had it.

mattphillips added 3 commits January 29, 2022 21:53

Add module name mapper to src directory

db62f1f

Condense toBeAfter into one file

589ac34

Disable all matchers test

8246b83

Condense fail into one file

2a92a7b

mattphillips force-pushed the mp/restructure branch from 1f703d1 to 2a92a7b Compare January 31, 2022 09:48

mattphillips added 2 commits January 31, 2022 10:05

Condense pass matcher into one file

5daecb1

Fix lint errors

39f303a

mattphillips force-pushed the mp/restructure branch 2 times, most recently from 7408597 to c8a26ee Compare January 31, 2022 10:37

mattphillips added 5 commits January 31, 2022 10:39

Condense toBeAfterOrEqualTo matcher into one file

29ab13f

Condense toBeArray matcher into one file

6dd14e6

Condense toBeArrayOfSize matcher into one file

f689d25

Condense toBeBefore matcher into one file

df3f191

Condense toBeBeforeOrEqualTo matcher into one file

225235d

mattphillips force-pushed the mp/restructure branch 2 times, most recently from 936d4b8 to d84291f Compare January 31, 2022 10:43

Fix broken snapshots

b6e429c

mattphillips force-pushed the mp/restructure branch from d84291f to b6e429c Compare January 31, 2022 10:43

mattphillips added 10 commits January 31, 2022 10:49

Condense toBeBetween matcher into one file

f09acad

Condense toBeBoolean matcher into one file

789f360

Condense toBeDate matcher into one file

dbbcb7c

Condense toBeDateString matcher into one file

df87bc5

Condense toBeEmpty matcher into one file

b948a9d

Condense toBeEmptyObject matcher into one file

6b69371

Condense toBeEven matcher into one file

7af5b38

Condense toBeExtensible matcher into one file

fa1e3c1

Remove lambdas from messages

3d1a693

Condense toBeFalse matcher into one file

8bc3771

mattphillips added 13 commits January 31, 2022 15:52

Condense toPartiallyContain matcher into one file

7493919

Condense toReject matcher into one file

db7c0a5

Condense toResolve matcher into one file

39506a8

Condense toSatisfy matcher into one file

5dfbd60

Condense toSatisfyAll matcher into one file

a8a9850

Condense toSatisfyAny matcher into one file

800da58

Condense toStartWith matcher into one file

b15ac5c

Condense toThrowWithMessage matcher into one file

bb24d0a

Rename toBeTrue test file

410255e

Move matchers integration test to test namespace

1b160e4

Move util tests to test namespace

f585c8b

Update contributing docs

f629315

Add tests for missing coverage

e72dd14

mattphillips marked this pull request as ready for review January 31, 2022 16:38

mattphillips changed the title ~~[WIP] Restructure project~~ Restructure project Jan 31, 2022